@colony/colony-js-utils
Advanced tools
Utilities for colonyJS packages.
yarn add @colony/colony-js-utils
import { raceAgainstTimeout } from '@colony/colony-js-utils';
class MyClass {
async somethingVerySlow() {
return mySlowPromise();
}
async doSomethingCoolAsync() {
// Will either return the result of `somethingVerySlow()` or throw throw an error on timeout
return raceAgainstTimeout(this.somethingVerySlow(), 30000);
}
async doSomethingElse() {
// Will do something on timeout, e.g. remove an event listener
return raceAgainstTimeout(
this.somethingVerySlow(),
30000,
() => this.removeEventListener('something'),
);
}
}
This package is part of the colonyJS monorepo.
Please read our contributing guidelines.
v1.12.0
This release implements significant changes and additions that enables support for the colonyNetwork glider-rc.1 release. Please do not hesitate to reach out to us on Discourse or Gitter if you are having any issues updating to this release.
Also, please note that colonyJS is currently using ethers version 3.0.27.
New Features
goerli as a getNetworkClient option (@colony/colony-js-client)goerli to network loader (@colony/colony-js-contract-loader-network)Types
[number] param type (@colony/colony-js-contract-client)tokenAddress param type to anyAddress to better reflect its uses (@colony/colony-js-contract-client)Maintenance
Updated constants (@colony/colony-js-client)
COLONY_ROLE_ADMINISTRATIONCOLONY_ROLE_ARBITRATIONCOLONY_ROLE_ARCHITECTURECOLONY_ROLE_ARCHITECTURE_SUBDOMAINCOLONY_ROLE_FUNDINGCOLONY_ROLE_RECOVERYCOLONY_ROLE_ROOTCOLONY_ROLESETHER_ADDRESSFUNDING_POT_TYPE_DOMAINFUNDING_POT_TYPE_PAYMENTFUNDING_POT_TYPE_TASKFUNDING_POT_TYPE_UNASSIGNEDFUNDING_POT_TYPESTASK_RATING_NONETASK_RATING_UNSATISFACTORYTASK_RATING_SATISFACTORYTASK_RATING_EXCELLENTTASK_RATINGSTASK_ROLE_EVALUATORTASK_ROLE_MANAGERTASK_ROLE_WORKERTASK_ROLESFOUNDER_ROLE
FOUNDER_ROLE has been deprecated in favor of the new colony roles. When using the setFounderRole method provided by the OldRoles.sol extension contract, the following colony roles will be applied:
COLONY_ROLE_ROOTCOLONY_ROLE_ARCHITECTURECOLONY_ROLE_FUNDINGCOLONY_ROLE_ADMINISTRATIONADMIN_ROLE
ADMIN_ROLE has been deprecated in favor of the new colony roles. When using the setAdminRole method provided by the OldRoles.sol extension contract, the following colony roles will be applied:
COLONY_ROLE_ARCHITECTURECOLONY_ROLE_FUNDINGCOLONY_ROLE_ADMINISTRATIONAUTHORITY_ROLES
AUTHORITY_ROLES has been replaced by COLONY_ROLESMANAGER_ROLE
MANAGER_ROLE has been replaced with TASK_ROLE_MANAGEREVALUATOR_ROLE
EVALUATOR_ROLE has been replaced with TASK_ROLE_EVALUATORWORKER_ROLE
WORKER_ROLE has been replaced with TASK_ROLE_WORKERACTIVE_TASK_STATUS
ACTIVE_TASK_STATUS has been replaced with TASK_STATUS_ACTIVECANCELLED_TASK_STATUS
CANCELLED_TASK_STATUS has been replaced with TASK_STATUS_CANCELLEDFINALIZED_TASK_STATUS
FINALIZED_TASK_STATUS has been replaced with TASK_STATUS_FINALIZEDTASK_ROLES
TASK_ROLES has been updated to use the following reformatted constants:
TASK_ROLE_MANAGERTASK_ROLE_EVALUATORTASK_ROLE_WORKERUpdated caller methods in ColonyClient (@colony/colony-js-client)
getAuthorityAddressgetColonyNetworkAddressgetExtensionAddressgetFundingPotPayoutgetOwnerAddressgetPaymentgetPaymentCountgetTaskWorkRatingSecretsInfogetTokenAddresshasColonyRoleverifyReputationProofgetAuthority
getAuthorityAddress has replaced getAuthority.getTaskWorkRatings
getTaskWorkRatingSecretsInfo has replaced getTaskWorkRatings.getToken
getTokenAddress has replaced getToken.getTotalTaskPayout
getFundingPotPayout has replaced getTotalTaskPayout.hasUserRole
hasColonyRole has replaced hasUserRole. hasColonyRole uses address instead of user as an input parameter and adds domainId.getDomain
localSkillId output parameter to skillId.getFundingPot
associatedType output parameter to type.associatedTypeId output parameter to typeId.payoutsWeCannotMake output parameter.getRewardPayoutInfo
RewardPayoutCycle struct.getTask
payoutsWeCannotMake output parameter.Updated sender methods in ColonyClient (@colony/colony-js-client)
addExtensionaddNetworkColonyVersion (MetaColony)addPaymentaddTaskclaimPaymentclaimTaskPayoutclaimRewardPayoutdeprecateGlobalSkill (MetaColony)finalizePaymentremoveExtensionsetAdministrationRolesetArchitectureRolesetFundingRolesetPaymentDomainsetPaymentPayoutsetPaymentRecipientsetPaymentSkillsetRootRoleclaimPayout
claimPayment and claimTaskPayout for more information.createTask
addTask has replaced createTask for consistency.removeAdminRole (See setAdminRole)addGlobalSkill
parentSkillId as an input parameter. Global skills no longer exist within a skills tree and always use 0 for the parentSkillId.bootstrapColony
users input parameter to addresses.makePayment
worker input parameter to recipient.removeRecoveryRole
user input parameter to address.setRecoveryRole
user input parameter to address.setAdminRole
setAdminRole is now connected to the OldRoles extension contract.user input parameter to address.setTo input parameter.setFounderRole
setAdminRole is now connected to the OldRoles extension contract.user input parameter to address.setTaskEvaluatorRole
user input parameter to address.setTaskManagerRole
user input parameter to address.setTaskWorkerRole
user input parameter to address.startNextRewardPayout
key input parameter.value input parameter.branchMask input parameter.siblings input parameter.Updated events in ColonyClient (@colony/colony-js-client)
ColonyAdministrationRoleSetColonyArchitectureRoleSetColonyFundingRoleSetColonyRootRoleSetColonyVersionAddedPaymentAddedPayoutClaimedColonyAdminRoleRemoved
ColonyAdministrationRoleSet has replaced ColonyAdminRoleRemoved.ColonyAdministrationRoleSet changes user parameter to address.ColonyAdministrationRoleSet adds setTo parameter.ColonyAdminRoleSet
ColonyAdministrationRoleSet has replaced ColonyAdminRoleRemoved.ColonyAdministrationRoleSet changes user parameter to address.ColonyAdministrationRoleSet adds setTo parameter.ColonyFounderRoleSet
ColonyRootRoleSet has replaced ColonyFounderRoleSet.ColonyRootRoleSet changes user parameter to address.ColonyRootRoleSet adds setTo parameter.TaskPayoutClaimed
PayoutClaimed has replaced TaskPayoutClaimed.ColonyBootstrapped
users parameter to addresses.ColonyInitialised
token parameter.Updated caller methods in ColonyNetworkClient (@colony/colony-js-client)
calculateMinerWeightgetENSRegistrarAddressgetMiningResolverAddressgetReplacementReputationUpdateLogEntrygetReputationMiningCyclegetReputationMiningSkillIdgetReputationRootHashgetReputationRootHashNodeCountgetTokenLockingAddressgetRootGlobalSkillId
getReputationMiningSkillId has replaced getRootGlobalSkillId.getTokenLocking
getTokenLockingAddress has replaced getTokenLocking.getTokenLockingAddress changes lockingAddress parameter to address.getSkill
parents output parameter.children output parameter.Updated sender methods in ColonyNetworkClient (@colony/colony-js-client)
appendReputationUpdateLogdeprecateSkillinitialiseReputationMiningregisterColonyLabelsetMiningResolversetReplacementReputationUpdateLogEntrysetReputationRootHashstartNextMiningCycleaddSkill
globalSkill input parameter.removeRecoveryRole
user input parameter to address.setRecoveryRole
user input parameter to address.Updated events in ColonyNetworkClient (@colony/colony-js-client)
ColonyVersionAddedUpdated caller methods in TokenClient (@colony/colony-js-client)
isLockedUpdated sender methods in TokenClient (@colony/colony-js-client)
createTokenAuthorityunlockcreateToken
name and decimals input parameters.FAQs
Utilities for Colony JS packages
The npm package @colony/colony-js-utils receives a total of 46 weekly downloads. As such, @colony/colony-js-utils popularity was classified as not popular.
We found that @colony/colony-js-utils demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 7 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Python has adopted a standardized lock file format to improve reproducibility, security, and tool interoperability across the packaging ecosystem.
Security News
OpenGrep has restored fingerprint and metavariable support in JSON and SARIF outputs, making static analysis more effective for CI/CD security automation.
Security News
Security experts warn that recent classification changes obscure the true scope of the NVD backlog as CVE volume hits all-time highs.